com.inscoper.nbo.RasterScanner

Represents the XML element RasterScanner. More...

Inherits from com.inscoper.nbo.ConfocalScanner_Type, com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	RasterScanner()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString() Serializes this object to an XML string.
void	setType(RasterScannerType_Type value) Sets the value of the Type attribute.
RasterScannerType_Type	getType() Returns the value of the Type attribute.
void	resetType() Resets the Type attribute to an unset state.
boolean	hasType() Checks whether the optional Type attribute is present.
void	setHorizontalScanningSpeed(float value) Sets the value of the HorizontalScanningSpeed attribute.
float	getHorizontalScanningSpeed() Returns the value of the HorizontalScanningSpeed attribute.
void	resetHorizontalScanningSpeed() Resets the HorizontalScanningSpeed attribute to an unset state.
boolean	hasHorizontalScanningSpeed() Checks whether the optional HorizontalScanningSpeed attribute is present.
void	setHorizontalScanningSpeedUnit(UnitsVelocity_Type value) Sets the value of the HorizontalScanningSpeedUnit attribute.
UnitsVelocity_Type	getHorizontalScanningSpeedUnit() Returns the value of the HorizontalScanningSpeedUnit attribute.
void	resetHorizontalScanningSpeedUnit() Resets the HorizontalScanningSpeedUnit attribute to an unset state.
boolean	hasHorizontalScanningSpeedUnit() Checks whether the optional HorizontalScanningSpeedUnit attribute is present.
void	setVerticalScanningSpeed(float value) Sets the value of the VerticalScanningSpeed attribute.
float	getVerticalScanningSpeed() Returns the value of the VerticalScanningSpeed attribute.
void	resetVerticalScanningSpeed() Resets the VerticalScanningSpeed attribute to an unset state.
boolean	hasVerticalScanningSpeed() Checks whether the optional VerticalScanningSpeed attribute is present.
void	setVerticalScanningSpeedUnit(UnitsVelocity_Type value) Sets the value of the VerticalScanningSpeedUnit attribute.
UnitsVelocity_Type	getVerticalScanningSpeedUnit() Returns the value of the VerticalScanningSpeedUnit attribute.
void	resetVerticalScanningSpeedUnit() Resets the VerticalScanningSpeedUnit attribute to an unset state.
boolean	hasVerticalScanningSpeedUnit() Checks whether the optional VerticalScanningSpeedUnit attribute is present.
RasterScanner	__internal_create(long cPtr, boolean own)

Protected Functions

	Name
	RasterScanner(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(RasterScanner obj)

Additional inherited members

Public Functions inherited from com.inscoper.nbo.ConfocalScanner_Type

	Name
	ConfocalScanner_Type()
void	setID(ConfocalScannerID_Type value) Sets the value of the ID attribute.
ConfocalScannerID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(Denomination_Type value) Sets the value of the Name attribute.
Denomination_Type	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the optional Name attribute is present.
void	setNrOfScanPoints(int value) Sets the value of the NrOfScanPoints attribute.
int	getNrOfScanPoints() Returns the value of the NrOfScanPoints attribute.
void	setMaxFrameRate(float value) Sets the value of the MaxFrameRate attribute.
float	getMaxFrameRate() Returns the value of the MaxFrameRate attribute.
void	resetMaxFrameRate() Resets the MaxFrameRate attribute to an unset state.
boolean	hasMaxFrameRate() Checks whether the optional MaxFrameRate attribute is present.
void	setMaxFrameRateUnit(UnitsFrequency_Type value) Sets the value of the MaxFrameRateUnit attribute.
UnitsFrequency_Type	getMaxFrameRateUnit() Returns the value of the MaxFrameRateUnit attribute.
void	resetMaxFrameRateUnit() Resets the MaxFrameRateUnit attribute to an unset state.
boolean	hasMaxFrameRateUnit() Checks whether the optional MaxFrameRateUnit attribute is present.
void	setPointsConfiguration(String value) Sets the value of the PointsConfiguration attribute.
String	getPointsConfiguration() Returns the value of the PointsConfiguration attribute.
void	resetPointsConfiguration() Resets the PointsConfiguration attribute to an unset state.
boolean	hasPointsConfiguration() Checks whether the optional PointsConfiguration attribute is present.
void	setAnnotationRef(AnnotationRef value) Sets the value of the AnnotationRef element.
AnnotationRef	getAnnotationRef() Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
boolean	hasAnnotationRef() Checks whether the optional AnnotationRef element is present.

Protected Functions inherited from com.inscoper.nbo.ConfocalScanner_Type

	Name
	ConfocalScanner_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.RasterScanner;

Represents the XML element RasterScanner.

A Raster Scanner is typically used for systematic periodic scanning (raster scanning) of the Laser beam or of the Specimen position, either in one or in two dimensions. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.delete

function RasterScanner

public RasterScanner()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.getChildren

function getSubElements

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.fromJsonFile

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.fromJsonString

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.fromXmlFile

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.fromXmlString

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.toXmlFile

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.toXmlString

function setType

public void setType(
    RasterScannerType_Type value
)

Sets the value of the Type attribute.

Parameters:

value The value to set

This field records the type of this Raster Scanner. In a Galvanometer-mirror based system, two galvanometer scan mirrors (one for each axis) direct the laser beam to any XY position in the field of view. In a Resonant system laser positioning in the x-axis is provided by a special resonant scan mirror which oscillates at a fixed frequency.

function getType

public RasterScannerType_Type getType()

Returns the value of the Type attribute.

Return: The value of the attribute

This field records the type of this Raster Scanner. In a Galvanometer-mirror based system, two galvanometer scan mirrors (one for each axis) direct the laser beam to any XY position in the field of view. In a Resonant system laser positioning in the x-axis is provided by a special resonant scan mirror which oscillates at a fixed frequency.

function resetType

public void resetType()

Resets the Type attribute to an unset state.

This field records the type of this Raster Scanner. In a Galvanometer-mirror based system, two galvanometer scan mirrors (one for each axis) direct the laser beam to any XY position in the field of view. In a Resonant system laser positioning in the x-axis is provided by a special resonant scan mirror which oscillates at a fixed frequency.

function hasType

public boolean hasType()

Checks whether the optional Type attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the type of this Raster Scanner. In a Galvanometer-mirror based system, two galvanometer scan mirrors (one for each axis) direct the laser beam to any XY position in the field of view. In a Resonant system laser positioning in the x-axis is provided by a special resonant scan mirror which oscillates at a fixed frequency.

function setHorizontalScanningSpeed

public void setHorizontalScanningSpeed(
    float value
)

Sets the value of the HorizontalScanningSpeed attribute.

Parameters:

value The value to set

This field records the maximal Horizontal Scanning Speed of this device.

function getHorizontalScanningSpeed

public float getHorizontalScanningSpeed()

Returns the value of the HorizontalScanningSpeed attribute.

Return: The value of the attribute

This field records the maximal Horizontal Scanning Speed of this device.

function resetHorizontalScanningSpeed

public void resetHorizontalScanningSpeed()

Resets the HorizontalScanningSpeed attribute to an unset state.

This field records the maximal Horizontal Scanning Speed of this device.

function hasHorizontalScanningSpeed

public boolean hasHorizontalScanningSpeed()

Checks whether the optional HorizontalScanningSpeed attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the maximal Horizontal Scanning Speed of this device.

function setHorizontalScanningSpeedUnit

public void setHorizontalScanningSpeedUnit(
    UnitsVelocity_Type value
)

Sets the value of the HorizontalScanningSpeedUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getHorizontalScanningSpeedUnit

public UnitsVelocity_Type getHorizontalScanningSpeedUnit()

Returns the value of the HorizontalScanningSpeedUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetHorizontalScanningSpeedUnit

public void resetHorizontalScanningSpeedUnit()

Resets the HorizontalScanningSpeedUnit attribute to an unset state.

No description available in the XSD standard.

function hasHorizontalScanningSpeedUnit

public boolean hasHorizontalScanningSpeedUnit()

Checks whether the optional HorizontalScanningSpeedUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setVerticalScanningSpeed

public void setVerticalScanningSpeed(
    float value
)

Sets the value of the VerticalScanningSpeed attribute.

Parameters:

value The value to set

This field records the maximal Vertical Scanning Speed of this device.

function getVerticalScanningSpeed

public float getVerticalScanningSpeed()

Returns the value of the VerticalScanningSpeed attribute.

Return: The value of the attribute

This field records the maximal Vertical Scanning Speed of this device.

function resetVerticalScanningSpeed

public void resetVerticalScanningSpeed()

Resets the VerticalScanningSpeed attribute to an unset state.

This field records the maximal Vertical Scanning Speed of this device.

function hasVerticalScanningSpeed

public boolean hasVerticalScanningSpeed()

Checks whether the optional VerticalScanningSpeed attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the maximal Vertical Scanning Speed of this device.

function setVerticalScanningSpeedUnit

public void setVerticalScanningSpeedUnit(
    UnitsVelocity_Type value
)

Sets the value of the VerticalScanningSpeedUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getVerticalScanningSpeedUnit

public UnitsVelocity_Type getVerticalScanningSpeedUnit()

Returns the value of the VerticalScanningSpeedUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetVerticalScanningSpeedUnit

public void resetVerticalScanningSpeedUnit()

Resets the VerticalScanningSpeedUnit attribute to an unset state.

No description available in the XSD standard.

function hasVerticalScanningSpeedUnit

public boolean hasVerticalScanningSpeedUnit()

Checks whether the optional VerticalScanningSpeedUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function __internal_create

public static RasterScanner __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.__internal_create

Protected Functions Documentation

function RasterScanner

protected RasterScanner(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.ConfocalScanner_Type.finalize

function getCPtr

protected static long getCPtr(
    RasterScanner obj
)

Updated on 2026-02-13 at 16:11:06 +0100